Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ns-inspect plugin #4135

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add ns-inspect plugin #4135

wants to merge 1 commit into from

Conversation

Rookie0031
Copy link

@Rookie0031 Rookie0031 commented Oct 13, 2024 •
edited
Loading

Description

This PR adds the kubectl-ns-inspect plugin to the Krew index. kubectl-ns-inspect is a utility plugin that inspects all the namespaces in current Kubernetes cluster and see if it contains any resources (e.g., Pods, Services, ConfigMaps, ResourceQuotas, etc.) judge it is useless or not.

If the namespace is deemed useless (there is no Pod, Service, ResourceQuotas), the plugin can optionally prompt the user to delete the namespace.

Features

1. Namespace Resource Inspection:

  • The plugin inspects all namespaces within a cluster to check for resources such as Pods, Services, ConfigMaps, and ResourceQuotas.
    If a namespace is considered useless, the plugin lists all remaining resources within the namespace and prompts the user to delete it.

2. Dry-run Option:

  • The plugin supports a dry-run mode, which allows users to list the namespaces and their contents without performing any deletions.

3. Current Context-Based Operation:

  • The plugin operates based on the current Kubernetes context.
    It uses the context specified in the KUBECONFIG environment variable, or defaults to $HOME/.kube/config if the variable is not set.

Usage

kubectl ns-inspect
image

Check

  1. It follows Plugin Naming Guide
  2. Verified I can install my plugin locally

@Rookie0031
Add ns-inspect plugin
cdb7628 
- This plugin checks Kubernetes namespaces for resources and allows users to delete empty namespaces.

- Inspect if there is useless namespace and optionally delete it
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Oct 13, 2024 •
edited
Loading

CLA Signed


The committers listed above are authorized under a signed CLA.

@ahmetb
Copy link
Member

ahmetb commented Oct 13, 2024

🤖 Beep beep! I’m a robot speaking on behalf of @ahmetb. 🤖

Thanks for submitting your kubectl plugin to Krew!
One of the krew-index maintainers will review it soon. Note that the reviews for new plugin submissions may take a few days.

In the meanwhile, here are a few tips to make your plugin manifest better:

  • Make sure your plugin follows the best practices.
  • Eliminate redundant wording form shortDescription (it should be max 50 characters).
  • Try to word wrap your description to 80-character lines (no usage examples, please).

Thanks for your patience!
/kind new-plugin

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Rookie0031
Once this PR has been reviewed and has the lgtm label, please assign chriskim06 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. kind/new-plugin labels Oct 13, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @Rookie0031!

It looks like this is your first PR to kubernetes-sigs/krew-index 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/krew-index has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 13, 2024
@ahmetb
Copy link
Member

ahmetb commented Oct 15, 2024

judge it is useless or not.

Yeah I'm afraid kubectl get-all -n plugin does this, and it's not limited to certain resources.

@Rookie0031
Copy link
Author

judge it is useless or not.

Yeah I'm afraid kubectl get-all -n plugin does this, and it's not limited to certain resources.

Got it, but I wanted to highlight a few differences:

  1. Output Format: kubectl get-all lists resources but doesn’t summarize their usefulness. My plugin evaluates each namespace and prompts the user to delete unneeded ones, making decision-making easier.

2.Feature Differentiation: My plugin focuses on assessing specific resource types, helping users manage namespaces more effectively, whereas kubectl get-all can be overwhelming with too much information.

Please consider the points above !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chriskim06 chriskim06 Awaiting requested review from chriskim06

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/new-plugin size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Rookie0031 @ahmetb @k8s-ci-robot